WorkflowEnded<'Result>Type

PackageFCQRS.Workflows
How one element's workflow ended, as `WorkflowFlow.Run` emits it to C#.

Specification

Kind
Type
Members
7
Examples
0
``.ctor``Signature
WorkflowEnded(id, outcome)
IsFaultedSignature
this.IsFaulted
IsFinishedSignature
this.IsFinished
ErrorSignature
this.Error
IdSignature
this.Id

Summary

NameSignatureSynopsis
``.ctor``WorkflowEnded(id, outcome)No description available.
IsFaultedthis.IsFaultedTrue when the body threw an exception it did not handle.
IsFinishedthis.IsFinishedTrue when the body returned a value.
Errorthis.ErrorThe stored failure when `IsFaulted` is true, and null otherwise.
Idthis.IdThe workflow ID computed from the element.
IsCancelledthis.IsCancelledTrue when the workflow was cancelled.
Resultthis.ResultThe body's return value when `IsFinished` is true, and the type's default otherwise.

``.ctor``

WorkflowEnded(id, outcome)
Member

Parameters

NameTypeDescription
idstring
outcomeWorkflowOutcome<'Result>

Returns

WorkflowEnded<'Result>

IsFaulted

this.IsFaulted
Member
True when the body threw an exception it did not handle.

Returns

bool

IsFinished

this.IsFinished
Member
True when the body returned a value.

Returns

bool

Error

this.Error
Member
The stored failure when `IsFaulted` is true, and null otherwise.

Returns

StepError

Id

this.Id
Member
The workflow ID computed from the element.

Returns

string

IsCancelled

this.IsCancelled
Member
True when the workflow was cancelled.

Returns

bool

Result

this.Result
Member
The body's return value when `IsFinished` is true, and the type's default otherwise.

Returns

'Result